Tip Menu

The Tip Menu is a list of menu items that viewers can tip for. Each menu item has a name, price, and description.

Test Tip Menu

You can click the "Test Tip Menu" button to see how your Tip Menu will look in your chat.

Command

This is the command that viewers can type in chat to see the Tip Menu. Leaving this field blank will disable the command.

Auto Message Interval

You can set an interval for the bot to automatically send the Tip Menu in chat. You can either send it every X minutes or every X messages. Setting this to 0 will disable the auto message.

Tip Message

This is the message that will be sent in chat when a viewer tips for a menu item. Viewers have to tip the amount specified in the menu item to trigger this message. Leaving this field blank will disable the tip message.

Variables

• {user} - The username of the tipper
• {item.name} - The name of the tipped menu item
• {item.description} - The description of the tipped menu item
• {item.price} - The price of the tipped menu item

Progression Message

This is the message that will be sent once when a purchased tip menu item or a completed tip goal applies one or more progressions. Leaving this field blank will disable progression announcements.

If multiple progression entries are applied by the same trigger, the bot combines them into a single progression message.

Variables

• {trigger} - A human-readable summary of what triggered the progression. Example: Item "Trigger" was purchased
• {action} - A human-readable summary of everything the progression changed. Example: Unlocked "Unlock A" and "Unlock B" and switched to preset "Afterparty Preset"
• {trigger.item.name} - The purchased tip menu item name when the trigger type is Tip Menu Item Purchased. Example: Trigger
• {trigger.goal.label} - The selected goal label when the trigger type is Tip Goal Completed. Example: Goal
• {action.item.names} - A comma-separated list of unlocked item names. Example: Unlock A, Unlock B
• {action.preset.name} - The preset name that was switched to. Example: Afterparty Preset
• {trigger.item.count} - The number of selected trigger items on the matched item-based progression. Example: 2

Example:

{trigger}: {action}

Output:

Item "Trigger" was purchased: Unlocked "Unlock A" and "Unlock B"

Item-based example:

Progression update: {trigger.item.name} -> {action}

Output:

Progression update: Trigger -> Unlocked "Unlock A" and "Unlock B"

Goal-based example:

{trigger.goal.label} -> {action.preset.name}

Output:

Goal -> Goal Target Preset

Menu Template

You can change the template of the Tip Menu to your liking. It can dynamically display the menu items depending on how you set it up. If you want to use a dynamic list based on the menu items you set, you have to use the {items} tag to begin the list and the {/items} tag to end the list.

This means that you don't have to manually list the menu items in the template yourself if you use the template correctly. It will automatically display the menu items based on the ones you have enabled.

Variables

• {items} - Start and end marker for the list of menu items
• {item.name} - The name of the tip menu item
• {item.description} - The description of the tip menu item
• {item.price} - The price of the tip menu item

Example 1:

My Tip Menu

{items}
- ${item.price} | {item.name}
{/items}

Output 1:

My Tip Menu

- $1.00 | test1
- $1.50 | test1.5
- $2.00 | test2

Example 2:

My Tip Menu

{items}${item.price} | {item.name} 💙 {/items}

Output 2:

My Tip Menu

$1.00 | test1 💙 $1.50 | test1.5 💙 $2.00 | test2 💙

Tip Menu Items

You can add, edit, and delete menu items here. Each menu item has a name, price, description and can be enabled or disabled. The menu items will always be sorted by price in ascending order.

Tip Menu Items Presets

You can create presets for your tip menu items. This allows you to have different tip menu items for different occasions.

• One preset is active at a time.
• The active preset is the one used for the tip menu command and automatic tip menu messages.
• Progressions are saved per preset and only run while that preset is active.
• Duplicating a preset also duplicates that preset's progression entries.

Progressions

Progressions let your tip menu evolve automatically while viewers interact with it.

• Progressions are configured inside the currently selected preset.
• Only enabled progression entries can trigger.
• A progression can trigger from either a purchased tip menu item or a completed tip goal.
• A progression can either unlock one or more tip menu items or switch the active preset automatically.

Trigger Types

Tip Menu Item Purchased

• Select one or more trigger items from the current preset.
• The progression fires when any selected item is purchased.
• You can optionally enable Disable Trigger Items to turn those selected trigger items off after the progression fires.

Tip Goal Completed

• Select one tip goal.
• The progression fires when that goal completes.
• Goal-based progressions do not use trigger item selections.

Action Types

Unlock Tip Menu Item

• Select one or more items from the same preset to unlock.
• If you want an item to unlock later, disable that item manually in the preset first by turning its Enabled toggle off.
• Unlock progressions do not create a separate locked state. They simply enable the selected items again when the progression fires.
• Trigger items cannot also be selected as unlock targets.
• Only items that are currently disabled are changed; already enabled items are skipped automatically.

Switch Active Preset

• Select another preset as the target.
• When the progression fires, that preset becomes the active preset automatically.
• Switching to the already active preset does nothing.

Adding a Tip Menu Item

Price

Enter the price of the menu item. This is the amount viewers have to tip to trigger the tip message.

Enabled

You can enable or disable the menu item at any time. This allows you to keep the menu item without having to delete it.

Name

Enter the name of the menu item.

Description

You can also optionally enter a description for the menu item.

Random Selection

You can turn an item into a random trigger by enabling Random Reward.

• When that exact tip amount is used, one selected tip menu item is picked at random.
• Only non-random items from the same preset can be selected as random tip menu items.
• New random items start with all tip menu items disabled by default; you can select tip menu items manually or use Enable All.
• Disabled tip menu items can still be selected and remain eligible for random rewards.
• Removed, random, or otherwise invalid tip menu items are skipped automatically.
• If no eligible tip menu item remains, no tip message is sent for that tip.
• The selected tip menu item is used for {item.name}, {item.description}, and {item.price} in the tip message.

Sub Tier Discount

Sub tier discounts are per-item subscription tier discounts.

You can set per-tier discounts for this item. Choose a discount type per tier and enter a value.

• Percent: applies to the item price and is capped at 100.
• Fixed amount: subtracts a dollar amount from the item price.
• Discounted prices are rounded to 2 decimals and never go below $0.00.
• Discounts apply to the tip menu command display and the amount required to trigger the tip message for subscribers in that tier.
• If discounted prices are active for the viewer, the tip menu command adds a short discounted-prices note at the top.